1   /*
2    * Copyright (C) 2010 The Guava Authors
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package com.google.common.collect;
18  
19  import com.google.common.annotations.Beta;
20  import com.google.common.annotations.GwtCompatible;
21  
22  import java.util.Map;
23  import java.util.Set;
24  import java.util.SortedMap;
25  import java.util.SortedSet;
26  
27  /**
28   * Interface that extends {@code Table} and whose rows are sorted.
29   *
30   * <p>The {@link #rowKeySet} method returns a {@link SortedSet} and the {@link
31   * #rowMap} method returns a {@link SortedMap}, instead of the {@link Set} and
32   * {@link Map} specified by the {@link Table} interface.
33   *
34   * @author Warren Dukes
35   * @since 8.0
36   */
37  @GwtCompatible
38  @Beta
39  public interface RowSortedTable<R, C, V> extends Table<R, C, V> {
40    /**
41     * {@inheritDoc}
42     *
43     * <p>This method returns a {@link SortedSet}, instead of the {@code Set}
44     * specified in the {@link Table} interface.
45     */
46    @Override SortedSet<R> rowKeySet();
47  
48    /**
49     * {@inheritDoc}
50     *
51     * <p>This method returns a {@link SortedMap}, instead of the {@code Map}
52     * specified in the {@link Table} interface.
53     */
54    @Override SortedMap<R, Map<C, V>> rowMap();
55  }